<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Enums  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset='utf-8'>
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a title="Enums  Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="index.html">Spruce Docs</a> (100% documented)</p>
        <p class="header-right"><a href="https://github.com/willowtreeapps/spruce-ios"><img src="img/gh.png"/>View on GitHub</a></p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="index.html">Spruce Reference</a>
        <img id="carat" src="img/carat.png" />
        Enums  Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Classes/Button.html">Button</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/ViewController.html">ViewController</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Enums.html">Enums</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Enums/Angle.html">Angle</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Corner.html">Corner</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Direction.html">Direction</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Distance.html">Distance</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Position.html">Position</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Scale.html">Scale</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/SlideDirection.html">SlideDirection</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/StockAnimation.html">StockAnimation</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Weight.html">Weight</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Extensions/CGPoint.html">CGPoint</a>
              </li>
              <li class="nav-group-task">
                <a href="Extensions/UIView.html">UIView</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Protocols/Animation.html">Animation</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/CornerSortFunction.html">CornerSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/DirectionSortFunction.html">DirectionSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/DistanceSortFunction.html">DistanceSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/PositionSortFunction.html">PositionSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/SortFunction.html">SortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/View.html">View</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/WeightSortFunction.html">WeightSortFunction</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Structs.html">Structs</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Structs/ContinuousSortFunction.html">ContinuousSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/ContinuousWeightedSortFunction.html">ContinuousWeightedSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/CorneredSortFunction.html">CorneredSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/DefaultSortFunction.html">DefaultSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/InlineSortFunction.html">InlineSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/LinearSortFunction.html">LinearSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/RadialSortFunction.html">RadialSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/RandomSortFunction.html">RandomSortFunction</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SpringAnimation.html">SpringAnimation</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/Spruce.html">Spruce</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SprucePoint.html">SprucePoint</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/SpruceUIView.html">SpruceUIView</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/StandardAnimation.html">StandardAnimation</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs.html#/s:V6Spruce9TimedView">TimedView</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>Enums</h1>
            <p>The following enums are available globally.</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce9Direction"></a>
                    <a name="//apple_ref/swift/Enum/Direction" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce9Direction">Direction</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A representation of a linear direction.</p>

<ul>
<li>topToBottom: the animation will run with top views animating first and then bottom views animating last</li>
<li>bottomToTop: the animation will run with bottom views animating first and then top views animating last</li>
<li>leftToRight: the animation will run with left views animating first and right views animating last</li>
<li>rightToLeft: the animation will run with right views animating first and left views animating last</li>
</ul>

                        <a href="Enums/Direction.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Direction</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce14SlideDirection"></a>
                    <a name="//apple_ref/swift/Enum/SlideDirection" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce14SlideDirection">SlideDirection</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Direction that a slide animation should use.</p>

<ul>
<li>up: start the view below its current position, and then slide upwards to where it currently is</li>
<li>down: start the view above its current position, and then slide downwards to where it currently is</li>
<li>left: start the view to the right of its current position, and then slide left to where it currently is</li>
<li>right: start the view to the left of its current position, and then slide right to where it currently is</li>
</ul>

                        <a href="Enums/SlideDirection.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SlideDirection</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce5Angle"></a>
                    <a name="//apple_ref/swift/Enum/Angle" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce5Angle">Angle</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>How much the angle of an animation should change. This value changes based off of which type of <code><a href="Enums/StockAnimation.html">StockAnimation</a></code> is used.</p>

<ul>
<li>slightly: slightly animate the object</li>
<li>moderately: the object should move a moderate amount</li>
<li>severely: the object should move very noticeably</li>
<li>toAngle: provide your own angle value that you feel the object should rotate</li>
</ul>

                        <a href="Enums/Angle.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Angle</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce5Scale"></a>
                    <a name="//apple_ref/swift/Enum/Scale" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce5Scale">Scale</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>How much the scale of an animation should change. This value changes based off of which type of <code><a href="Enums/StockAnimation.html">StockAnimation</a></code> is used.</p>

<ul>
<li>slightly: slightly animate the object</li>
<li>moderately: the object should scale a moderate amount</li>
<li>severely: the object should scale very noticeably</li>
<li>toScale: provide your own scale value that you feel the object should grow/shrink</li>
</ul>

                        <a href="Enums/Scale.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Scale</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce8Distance"></a>
                    <a name="//apple_ref/swift/Enum/Distance" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce8Distance">Distance</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>How much the distance of a view animation should change. This value changes based off of which type of <code><a href="Enums/StockAnimation.html">StockAnimation</a></code> is used.</p>

<ul>
<li>slightly: slightly move the object</li>
<li>moderately: the object should move a moderate amount</li>
<li>severely: the object should move very noticeably</li>
<li>byPoints: provide your own distance value that you feel the object should slide over</li>
</ul>

                        <a href="Enums/Distance.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Distance</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce14StockAnimation"></a>
                    <a name="//apple_ref/swift/Enum/StockAnimation" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce14StockAnimation">StockAnimation</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A few stock animations that you can use with Spruce. We want to make it really easy for you to include animations so we tried to include the basics. Use these stock animations to <code>slide</code>, <code>fade</code>, <code>spin</code>, <code>expand</code>, or <code>contract</code> your views.</p>

                        <a href="Enums/StockAnimation.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">StockAnimation</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce8Position"></a>
                    <a name="//apple_ref/swift/Enum/Position" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce8Position">Position</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A position on the screen. Use this to define specific locations on the screen where the animation should start</p>

                        <a href="Enums/Position.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Position</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce6Weight"></a>
                    <a name="//apple_ref/swift/Enum/Weight" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce6Weight">Weight</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Represents the weighted values for computation</p>

<ul>
<li>light: a small value, 0.5</li>
<li>medium: a default value, 1.0</li>
<li>heavy: a large value, 2.0</li>
<li>custom: you can specify your own value for weight</li>
</ul>

                        <a href="Enums/Weight.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Weight</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:O6Spruce6Corner"></a>
                    <a name="//apple_ref/swift/Enum/Corner" class="dashAnchor"></a>
                    <a class="token" href="#/s:O6Spruce6Corner">Corner</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A representation of the corners of the view</p>

<ul>
<li>topLeft: top left corner of the view</li>
<li>topRight: top right corner of the view</li>
<li>bottomLeft: bottom left corner of the view</li>
<li>bottomRight: bottom right corner of the view</li>
</ul>

                        <a href="Enums/Corner.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Corner</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2017 <a class="link" href="https://willowtreeapps.com" target="_blank" rel="external">WillowTree</a>. All rights reserved. (Last updated: 2017-03-10)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>
